home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / cal14s24.zip / CALLS.DOC < prev    next >
Text File  |  1992-10-29  |  20KB  |  507 lines
  1.  
  2.                              CALLS.EXE
  3.  
  4.               Call analyzer for PCBoard versions 11.7 
  5.   (updated for PCBoard 11.8 and PCB/ProDOOR, S.H.Smith, 07/05/87)
  6.           (updated for PCBoard 14.x, S.H.Smith, 01-17-91)
  7.  
  8.  
  9.      Note:  Warren Lauzon is no longer supporting this program 
  10.                (since he's completely rewriting it)
  11.         So, please don't bother him with support questions.
  12.  
  13.               If you need help with it, contact me at
  14.                          Samuel H. Smith,
  15.                        Sysop, The Tool Shop
  16.  
  17.                    Phone number         Modem type
  18.                   --------------    ---------------------
  19.                   (818) 891-3772    US Robotics HST 9600
  20.                   (818) 891-1344    Four v.32bis 14400 lines
  21.                   (818) 891-6780    Hayes-V series 9600 (free line)
  22.  
  23.  
  24.                  CHANGE HISTORY (in reverse order)
  25.                  =================================
  26.  
  27. Added logic to strip the leading 'CONNECT' or 'CARRIER' from the connect
  28. types report.
  29.  
  30. Added logic to count opening chat doors as a "node chat".
  31.  
  32. Added logic to count all (Local) connect types as sysop local sessions.
  33.  
  34. Added SUBTITLE option to allow a variable subtitle to be included in
  35. each report.
  36.  
  37. Added PEAK AUTO option to automatically report the top 6 hours as the
  38. peak hours of the day.
  39.  
  40. Version 14s24 29-Oct-92 S.H.Smith
  41. -----------------------------------------------------------------------
  42.  
  43.  
  44. Corrected an error that would cause a lockup on OPENED DOOR log entries
  45. that contain "\" as part of the doorname.
  46.  
  47. Version 14s23 09-Jan-92 S.H.Smith
  48. -----------------------------------------------------------------------
  49.  
  50.  
  51. The "security level" reports were generating duplicate entries for some
  52. security levels.  You will have to delete CALLS.SAV and let CALLS
  53. rebuild it.
  54.  
  55. Version 14s22 08-Dec-91 S.H.Smith
  56. -----------------------------------------------------------------------
  57.  
  58.  
  59. Changed to accept new format of "new user registration" and "caller
  60. security level" enerated by pcboard 14.5.
  61.  
  62. Version 14s21 17-Jan-91 S.H.Smith
  63. -----------------------------------------------------------------------
  64.  
  65.  
  66. Added new report code 'R' to report "Minutes Used by Security Level".
  67. Renamed report code 'O' to "Number of Calls by Security Level".
  68.  
  69. Version 14s20 13-Apr-90 S.H.Smith
  70. -----------------------------------------------------------------------
  71.  
  72.  
  73. The "Free Download" and "Connect Type" reports were being interchanged
  74. in the .SAV file; this has been corrected, but old .SAV files must be
  75. rebuilt before these reports will be correct.
  76.  
  77. Added new EVENTMODE option to control how event time is reported.  The
  78. options are:
  79.  
  80.         EVENTMODE OFF   ;this option disables calculation of event
  81.                         ;duration
  82.  
  83.         EVENTMODE BUSY  ;this mode calculates event duration and
  84.                         ;accounts for it as 'busy' time (i.e. the system
  85.                         ;was in use during this time)
  86.  
  87.         EVENTMODE IDLE  ;this mode calculates event duration and
  88.                         ;accounts for it as 'idle' time (i.e. the system
  89.                         ;was NOT in use during this time)
  90.  
  91. Changed "event duration" reported to average minutes per event instead
  92. of total minutes for all events.
  93.  
  94. Added 29 new protocol codes:
  95.         0 1 2 3 4 5 6 7 8 9 ! @ # $ % ^ & * + - < > / [ ] { } ` ~
  96.  
  97. Added a counter of MarkMail messages left on the system.
  98. Corrected an error in baud rate calculation when baud rates included "E".
  99.  
  100.  
  101. Version 14s19 16-Feb-90 S.H.Smith
  102. -----------------------------------------------------------------------
  103.  
  104.  
  105. Added reports for ProDoor's "Free Download" feature.  This report is
  106. enabled with report code "Q".  Use the MAXFREE option to control the
  107. maximum number of filenames to be reported.
  108.  
  109. Moved samples configuration files to a sub-archive.
  110.  
  111. Version 14s18 13-Jan-90 S.H.Smith
  112. -----------------------------------------------------------------------
  113.  
  114.  
  115. Dates after 12-31-89 were not correctly calculated.
  116.  
  117. Added reports for ProLogon's new "Connect type" and "Security level"
  118. caller log entries.
  119.  
  120. Version 14s17 04-Jan-90 S.H.Smith
  121. -----------------------------------------------------------------------
  122.  
  123.  
  124. See CALLS.DOC for an explanation of the files included in CAL14S16.ZIP.
  125.  
  126. Deleted all command line parameters and created a new configuration file
  127. format to control reporting.  See CALLS.CNF for example file format.
  128.  
  129. Corrected processing of 'NUL' input file option.
  130.  
  131. Corrected reporting of download efficiency on "G" protocols.
  132.  
  133. Changed efficiency tables to allow up to 150% in report.
  134.  
  135. Added libraries to allow shared reading of caller log files.
  136.  
  137. Added new config file options to control number of entries in conference,
  138. bulletin, doors, and batchSize reports.
  139.  
  140. Added new config file option to redefine protocol names in report.
  141.  
  142. Added new config file option to specify alternate CALLS.SAV file name.
  143.  
  144. Added calculation of time spend processing scheduled events.
  145.  
  146. Version 14s16 02-Aug-89 S.H.Smith
  147. -----------------------------------------------------------------------
  148.  
  149. Corrected logic for determination of first and last log entry dates
  150. on multi-node reports.
  151.  
  152. Version 14s15 24-Jul-89 S.H.Smith
  153. -----------------------------------------------------------------------
  154.  
  155. Changed message formats to support ProDoor 3.1 betas as of 7-12-89.
  156. Added support for new ProLogon baud rate information.
  157.  
  158. Added support for multi-node reporting.  Append /N to caller file name,
  159. where N is the highest node number.  The program will then sequentially
  160. scan the caller files and combine them for a single report.
  161.  
  162. Version 14s14 13-Jul-89 S.H.Smith
  163. -----------------------------------------------------------------------
  164.  
  165. Changed message formats to support ProDoor 3.0 betas as of 4-9-89.
  166. Added support for 38400 bps connect speeds.
  167.  
  168. Version 14s13 09-Apr-89 S.H.Smith
  169. -----------------------------------------------------------------------
  170.  
  171. Corrected the handling of empty caller logs.  This makes it possible to
  172. generate multiple reports from the same caller log by re-running the
  173. calls program with 'NUL' in place of the caller log filename.
  174. Eliminated the use of Borland's CRT unit.  Ansi codes are now used to
  175. control the local display.
  176.  
  177. Usage:
  178. -----
  179.  
  180. calls CALLERS-FILE OUTPUT-FILE REPORT-LIST MIN-DOWNLOAD PEAK-HOURS
  181.  
  182. CALLERS-FILE is your pcboard CALLER file.  Use "NUL" to repeat previous data.
  183. OUTPUT-FILE  defaults to BLT99
  184. REPORT-LIST  defaults to ANBCDEFGHIJKLM
  185. MIN-DOWNLOAD defaults to 2
  186.  
  187. PEAK-HOURS   defaults to YNNNNNNNNNNNNNNNNYYYYYYY
  188.                         {0         1         2   }
  189.                         {012345678901234567890123}
  190.  
  191. The legal REPORT-LIST letters are:
  192.    A: system statistics            B: graphic modes
  193.    C: baud rates                   D: hourly usage
  194.    E: conferences joined           F: bulletins read
  195.    G: doors opened                 H: download protocols
  196.    I: download efficiency          J: upload protocols
  197.    K: upload efficiency            L: batch sizes
  198.    M: files downloaded             N: security statistics
  199.                                    Z: insert a blank line
  200.  
  201. Examples:
  202.  
  203.   calls \pcb\main\caller \gen\blt3
  204.             ;uses default report list, min-download and peak-hours.
  205.  
  206.   calls \pcb\main\caller \gen\blt3 ABCEFG 4 NNNNNNNNYYYYYYYYYNNNNNNN
  207.             ;to specify peak hours you MUST also include 
  208.             ;the report-list and min-download paremeters.
  209.  
  210.   calls nul \gen\blt-usage D
  211.   calls nul \gen\blt-files M
  212.             ;repeat previous report date in different formats or to
  213.             ;alternate output files
  214.  
  215.  
  216. Sample EVENT.SYS lines for two node systems:
  217. -------------------------------------------
  218.  
  219. rem Update NODE 1 caller log database
  220. cd \pcb1
  221. type \pcb\main\daycal1 >>\pcb\main\caller1
  222. if exist calls.sav     calls \pcb\main\daycal1 \pcb\gen\BLT3 ANBCDEFGHIJKLM 3 NNNNNNNNNNNNNNNNYYYYYYNN
  223. if not exist calls.sav calls \pcb\main\caller1 \pcb\gen\BLT3 ANBCDEFGHIJKLM 3 NNNNNNNNNNNNNNNNYYYYYYNN
  224. copy \pcb\main\daycal1 \pcb\main\yester1
  225. copy \pcb\main\newcal1 \pcb\main\daycal1
  226.  
  227. rem Update NODE 2 caller log database
  228. cd \pcb2
  229. type \pcb\main\daycal2 >>\pcb\main\caller2
  230. if exist calls.sav     calls \pcb\main\daycal2 \pcb\gen\BLT4 ANBCDEFGHIJKLM 3 NNNNNNNNNNNNNNNNYYYYYYNN
  231. if not exist calls.sav calls \pcb\main\caller2 \pcb\gen\BLT4 ANBCDEFGHIJKLM 3 NNNNNNNNNNNNNNNNYYYYYYNN
  232. copy \pcb\main\daycal2 \pcb\main\yester2
  233. copy \pcb\main\newcal2 \pcb\main\daycal2
  234.  
  235. rem Create top uploaders/downloaders bulletin
  236. cd \pcb
  237. topusr main\users gen\blt5 20 4 120
  238.  
  239. Version 14s12 12-Mar-89 S.H.Smith
  240. -----------------------------------------------------------------------
  241.  
  242. Changes to allow 'ZIP' to be used instead of 'ARC'.
  243. Fixed some reports where 100.0% exceeded the margins.
  244. Corrected display of 'last caller log entry' on screen.
  245.  
  246. Version 14s11 27-Feb-89 S.H.Smith
  247. -----------------------------------------------------------------------
  248.  
  249. Rewrote file scanning procedures to sequentially access the caller log.
  250. This makes it possible to report from log files that have been partially
  251. corrupted by a text editor or another program failure.  Added a report
  252. of messages entered via the Qmail door.
  253.  
  254. Version 14s10 31-Jan-89 S.H.Smith
  255. -----------------------------------------------------------------------
  256.  
  257. Several statistics were double counting.  Improved format of hourly
  258. utilization graphic.  Added new statistic for CD-ROM library access.
  259. Slight speedup.
  260.  
  261. Version 14s9 29-Jan-89 S.H.Smith
  262. -----------------------------------------------------------------------
  263.  
  264. Corrected an error that prevented the report from counting callers with
  265. 'NEW' in their city name!  Uploads are no longer included in the list of
  266. files downloaded.
  267.  
  268. Version 14s8 10-Jan-89 S.H.Smith
  269. -----------------------------------------------------------------------
  270.  
  271. Removed case sensitivity on most caller log entries.
  272.  
  273. Version 14s7 05-Jan-89 S.H.Smith
  274. -----------------------------------------------------------------------
  275.  
  276. Added color output files.
  277. Added support for 4800 baud connections.
  278. Corrected formatting in bar graphs for items with 100%.
  279.  
  280. Version 14s6 31-Dec-88 S.H.Smith
  281. -----------------------------------------------------------------------
  282.  
  283. Removed ARC-specific terminology.  Updated for similar changes in
  284. ProDoor betas dated after 10-9-88.
  285.  
  286. Version 14s4 10-Oct-88 S.H.Smith
  287. -----------------------------------------------------------------------
  288.  
  289. Added a report of "Free Downloads" for compatibility with 9/30
  290. prodoor betas.
  291. Added a "Peak Hours" command line parameter.
  292. Deleted "Time Distribution" report because it was so slow and inaccurate.
  293.  
  294. Version 14s3 10-03-88 S.H.Smith
  295. -----------------------------------------------------------------------
  296.  
  297. Updated for new conference joined and bulletin read log formats.
  298. Added a check for empty caller log files.
  299.  
  300. Version 14s2 24-Sep-88 S.H.Smith
  301. -----------------------------------------------------------------------
  302.  
  303. Updated protocol letters for PCBoard 14 compatibility.
  304.  
  305. Version 14s1 20-Sep-88 S.H.Smith
  306. -----------------------------------------------------------------------
  307.  
  308. Updated new user registration for new PCB 14 message format.
  309.  
  310. Version 12s21 22-Jul-88 S.H.Smith
  311. -----------------------------------------------------------------------
  312.  
  313. Added support for node chat.
  314.  
  315. Version 12s20 22-Jun-88 S.H.Smith
  316. -----------------------------------------------------------------------
  317.  
  318. Added a new data file CALLS.DIR, and a new graph of Time Usage by Activity.
  319. Create the file CALLS.DIR in the current directory.  List all your download
  320. and upload directories in this file (one directory per line).   CALLS will
  321. use this to search for each file that has been downloaded or uploaded.  The
  322. files must be located to determine file size, which is used to calculate the
  323. minutes spent downloading and uploading.  File sizes are determined only the
  324. first time a file is seen.
  325.  
  326. Version 12s19 12-Jun-88 S.H.Smith
  327. -----------------------------------------------------------------------
  328.  
  329. Changed ARCM message counter to a long integer to prevent overflows.
  330.  
  331. Version 12s17 10-May-88 S.H.Smith
  332. -----------------------------------------------------------------------
  333.  
  334. Added support for ProDoor's new ARC Mail feature.
  335.  
  336. Version 12s16 16-Apr-88 S.H.Smith
  337. -----------------------------------------------------------------------
  338.  
  339. Added checks for 24:xx instead of 00:xx in some caller log entries.
  340. Should prevent some runtime errors.
  341.  
  342. Version 12s15 12-Mar-88 S.H.Smith
  343. -----------------------------------------------------------------------
  344.  
  345. Recompiled with stack and range check enabled - slower, but safer.
  346.  
  347. Version 12s14 11-Feb-88 S.H.Smith
  348. -----------------------------------------------------------------------
  349.  
  350. Improved bulletin activity report formatting.
  351. Made changes to allow caller logs with over 32000 entries.  Changed graphics
  352. to allow > 100% (for MNP modems in efficiency reporting).
  353.  
  354. Version 12s13 11-Feb-88 S.H.Smith
  355. -----------------------------------------------------------------------
  356.  
  357. Made the 'remote dos time' statistic work properly (broken ever since
  358. PCB 12.)   Added entries in protocol table for all letters of
  359. the aplhabet.
  360.  
  361. Version 12s12 19-Jan-88 S.H.Smith
  362. -----------------------------------------------------------------------
  363.  
  364.  
  365. Added the ability to store an internal summary of your caller log. 
  366. This makes it possible to add small daily caller logs and produce 
  367. the full report without keeping the whole caller log on file.  It 
  368. also reduces time spent scanning the log file. 
  369.  
  370. Each time CALLS is run, it looks for CALLS.SAV in the default 
  371. directory.  If it is present, it loads this "saved summary" into 
  372. memory and adds the specified caller file to it.  After the report 
  373. is generated, CALLS.SAV is updated to include the new data.   Here 
  374. is a recommended EVENT.SYS sequence: 
  375.  
  376.      1. cd \pcb
  377.      2. calls main\daycal gen\blt3 zzAzNBCDEFGHIJKLM 2
  378.      3. type main\daycal >>main\caller
  379.      4. del main\daycal
  380.  
  381. Use PCBSETUP to change the caller log filename from the usual 
  382. 'caller' to 'daycal' - this will be your "daily caller log".   
  383.  
  384. Line 2 runs the caller log report on the daily log and generates 
  385. BLT3.  Line 3 adds the daily caller log to the end of the 
  386. "historical" caller log.  Line 4 deletes the daily log (pcboard 
  387. will make a new one for you).   
  388.  
  389. If you are short on disk space, you don't even need to keep the 
  390. 'main\caller' - just delete it.  The information in CALLS.SAV will 
  391. be enough to generate the full caller log report. 
  392.  
  393. If for some reason you want to start over with a fresh log, just 
  394. delete 'calls.sav' and calls.exe will create a new one for you.   
  395.  
  396. If you don't want to take advantage of this 'daily caller log' 
  397. feature, just add the line 
  398.    del calls.sav
  399. before the 'calls \pcb\main ...' line in your event.sys - without 
  400. the .sav file, it will act just like it used to. 
  401.  
  402. Note: if you run CALLS twice on the same caller log, the 
  403. information will be added to CALLS.SAV twice!  So, either make a 
  404. backup copy of CALLS.SAV, or always delete daycal when you run 
  405. calls. 
  406.  
  407. Version 12s11 16-Jan-88 S.H.Smith
  408. -----------------------------------------------------------------------
  409.  
  410. Moved security related statistics to a new report (code 'N'). Added 
  411. a fourth parameter to specify the minimum number of downloads 
  412. needed to include a file in the files-downloaded report. 
  413.  
  414. Version 12s10 31-Dec-87 S.H.Smith
  415. -----------------------------------------------------------------------
  416.  
  417. Sorted entries in system statistics report.  Added reporting of 
  418. Archive test runs, archive extract runs and re-arc runs. 
  419.  
  420. Version 12s9 27-Dec-87 S.H.Smith
  421. -----------------------------------------------------------------------
  422.  
  423. Added a third command-line parameter to specify the reports to 
  424. generate. This lists the specific report sections to produce and 
  425. the order in which they will appear.   
  426.  
  427. If, for example, you wanted to produce only the hourly usage (D), 
  428. bulletins read (F), and system statistics (A) reports (in that 
  429. order), the command line would be: 
  430.    calls \pcb\main\caller \pcb\gen\blt3 DFA
  431.  
  432. -----------------------------------------------------------------------
  433.  
  434. Version 12s7 21-Dec-87
  435. Version 12s6 29-Nov-87
  436. Version 12s5 20-Nov-87
  437. Version 12s4 07-Nov-87
  438. Version 12s3 12-Oct-87
  439. Version 12s1 10-Oct-87
  440.  
  441.  
  442.  
  443.                       ORIGINAL DOCUMENTATION
  444.                       ======================
  445.  
  446.  
  447. Phoenix Arizona                                  Feb 23, 1987
  448.  
  449.      This documentation covers version 11.8 of CALLS118.COM, a 
  450. call analyzer for PCBoard 11.8. 
  451.      It was written in Turbo Pascal, and is in it's 7th update 
  452. with this version.  Previous versions had various names and 
  453. version numbers such as "pcbcalls", "calls5b" etc.  From now on, 
  454. it will carry the same version number as PCBoard.  If any 
  455. revisions are made or required, it will have a letter suffix. (ie 
  456. 117b). 
  457.      This version contains only minor mods to include changes made 
  458. in going from 11.6 to 11.7.  The Imodem and Gmodem protocols have 
  459. been added, some minor cleanup was done on the displays, and the 
  460. error file, BLT99.DOC has been eliminated as redundant and of not 
  461. much value. 
  462.  
  463. OPERATION
  464.  
  465.      This version works pretty much the same as all previous 
  466. versions with the exception that the error file "BLT99.DOC" has 
  467. been eliminated. 
  468.      The program is very easy to run, requiring only access to the 
  469. callers file.  This can be done in one of two ways: If you run it 
  470. from your 'MAIN' dir, you can just type CALLS118 and it will 
  471. default to an input file name of "CALLERS" and an called 
  472. "CALLFILE.DOC". 
  473.      It will also support command line parameters, so you can use 
  474. it in a batch file or in your "EVENT.SYS" file, as I do. The .COM 
  475. file should be in your \PCB dir, though this is not required.  
  476. Below is a sample of part of my .SYS file: 
  477.  
  478.   calls117 d:\pcb\main\callers e:\pcb\gen\blt10
  479.  
  480. Both parameters should be specified: the first one tells it where 
  481. to find the file (d:\pcb\main\callers) and the name of the callers 
  482. file.  The second tells it where to put the output file, in this 
  483. case I am sending it to Drive D with the name "BLT10". 
  484.  
  485. There are a couple of things that make for better operation: 
  486.   1.  Do not mix callers logs of pcboard 10.0 and 11.7.  I have
  487. heard of no problems mixing 11.6, 11.7 and 11.8.
  488.   2.  For proper operation, your clock and date MUST be correct; if 
  489. the programs finds that your log begins in 1987 and ends in 1980, 
  490. it will usually abort.  If not, the numbers will be totally wrong 
  491. in most cases. 
  492.   It is recommended, though not required, that you start a new 
  493. callers log if you are new to this program.  It is most accurate 
  494. when the log begins with "New callers log initiated "etc. 
  495.  
  496.      Please give it a try and let me know what you think of it, as 
  497. the only way I can put in needed changes is with feedback from the 
  498. users.  You can leave any comments at my board (Phoenix Techline) 
  499. at 602 936-3058 (1200-9600), 24 hours. 
  500.  
  501.      I have included the source code in this version so that it may 
  502. be customized if you desire.  If you make any major changes or 
  503. improvements, please upload them to my board at 602 936 3058. 
  504.  
  505.                           Warren Lauzon
  506.     
  507.